home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 11 / Cream of the Crop 11-1.iso / program / cpc2.zip / CP2.DOC < prev    next >
Text File  |  1995-12-31  |  15KB  |  710 lines
  1.  
  2.     Geist Microsystems                           CodePrint for C/C++
  3.         
  4.         
  5.     3.5   CodePrint OPTIONS ARRANGED BY CATEGORY
  6.         
  7.     -   Reformatter Options
  8.         
  9.     The options listed below provide control of the CodePrint 
  10.     reformatting feature.
  11.         
  12.          /A      Autoindent               /Jn     Justification      
  13.          /Kn     Keyword Templates        /R      Reformat
  14.          /S      Spaces                   /Tn     Tab Spacing
  15.          /Vn     Tab Conversion
  16.  
  17.     -   Pretty Printer Options
  18.         
  19.     The options listed below in addition to the reformat options 
  20.     above provide control of the CodePrint pretty printing feature. 
  21.         
  22.          /D      Doublestrike               /E      Emphasized 
  23.          /I      Italicized         
  24.         
  25.     -   Additional Print Control Options
  26.         
  27.     The options listed below provide additional print control.
  28.         
  29.          /Bn     Page Breaks              /Cn     Compressed 
  30.          /F      Flow Lines               /Gn     Configuration
  31.          /H      Header                   /L      Line Numbers
  32.          /Mn     Margin                   /N      Page Numbers
  33.          /O      Options                  /Pn     Printer Port 
  34.          /Q      Quick Print              /Wn     Carriage Width
  35.          /X      Extra Form Feed
  36.  
  37.         
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.     User Manual                                        Page 18 of 30
  60.  
  61.     Geist Microsystems                           CodePrint for C/C++
  62.  
  63.  
  64.  
  65.  
  66.  
  67.     C o d e P r i n t   f o r   C / C + + 
  68.  
  69.  
  70.     C h a p t e r   4
  71.  
  72.  
  73.     C o d e P r i n t   F e a t u r e s
  74.  
  75.  
  76.  
  77.  
  78.  
  79.     4.0   CodePrint FEATURES
  80.  
  81.     This chapter provides additional information about some of the 
  82.     more useful features of CodePrint.
  83.  
  84.  
  85.     4.1   REFORMATTER
  86.         
  87.     The /R option should be used when you wish to format source 
  88.     code.  This option cancels all printing options, leaving only 
  89.     reformatting options toggled on.  The /R option is equivalent to 
  90.     /B0 /D /E /H /I /L /M /N /P-1 /W /X.  If you wish to customize 
  91.     the formatting of your source code, you may use one or more of 
  92.     the "Reformatter" options listed in section 3.5.
  93.     
  94.  
  95.     4.2   PRETTY PRINTER
  96.         
  97.     All of the CP options are valid for pretty printing with two 
  98.     exceptions.  You cannot use the /P option or the /R option.  The 
  99.     /P option with an invalid argument cancels printing and the /R 
  100.     option cancels all of the printing options.  If you wish to 
  101.     customize the pretty printing of your source code, you may use
  102.     one or more of the "Pretty Printer" options listed in section 
  103.     3.5.
  104.         
  105.         
  106.     4.3   ON-LINE HELP
  107.         
  108.     CodePrint provides you with limited on-line help displaying CP 
  109.     command syntax and command-line options.  To invoke the on-line 
  110.     help just type: 
  111.         
  112.          C> CP 
  113.         
  114.     and press ENTER.
  115.         
  116.  
  117.  
  118.     User Manual                                        Page 19 of 30
  119.  
  120.     Geist Microsystems                           CodePrint for C/C++
  121.  
  122.  
  123.     4.4   BATCH PROCESSING AND PRINT SPOOLING
  124.         
  125.     CodePrint provides you with three methods of batch processing. 
  126.     First, you may enter more than one file on the command line.  
  127.     The command line is limited by DOS to 128 bytes.  The file names 
  128.     must be separated by spaces.  For example:
  129.         
  130.          C> CP FILE1.C FILE2.C FILE3.C
  131.         
  132.     ... or ...
  133.         
  134.          C> CP FILE1.CPP FILE2.CPP FILE3.CPP
  135.  
  136.     Second you may use the "*" and "?" wild cards in your file
  137.     specification.  For example:
  138.         
  139.          C> CP *.C       
  140.  
  141.     ... or ...
  142.         
  143.          C> CP *.CPP
  144.         
  145.     ... or ...
  146.         
  147.          C> CP FILE?.CPP
  148.         
  149.     ... or ...
  150.         
  151.          C> CP FILE?.C
  152.         
  153.     Third, you may process a file listing by entering the file 
  154.     listing name immediately preceded by the @ symbol. For example:
  155.         
  156.          C> CP @MYFILES.LST
  157.  
  158.     The file must be in standard ASCII format.  You may create these 
  159.     files with any text editor.  Each file name must be placed on a 
  160.     separate line.  The number of files you may enter in the file 
  161.     listing is limited to 100 when you are reformatting source code 
  162.     and by the size of the print queue when you are printing source 
  163.     code.  You may modify the size of the print queue with the
  164.     PRINT /Q:queuesize command.  Legal values for queuesize range 
  165.     from 1 to 32.  The default value is 10. 
  166.         
  167.     CodePrint makes use of the DOS PRINT spooler.  That means you do 
  168.     not have to wait for the printer to finish before you can 
  169.     continue to use your computer for other tasks.  CodePrint just 
  170.     loads files to print in the print queue and immediately returns 
  171.     control of the keyboard to you.  However, until the entire queue 
  172.     has been transfered to the printer, you may experience some 
  173.     annoying keyboard interrupts as you are typing. 
  174.         
  175.  
  176.  
  177.     User Manual                                        Page 20 of 30
  178.  
  179.     Geist Microsystems                           CodePrint for C/C++
  180.  
  181.  
  182.     4.5   KEYWORD TEMPLATES
  183.         
  184.     The keyword template is list of keywords for a specified 
  185.     programming language.  The templates also contain special 
  186.     characters that control the auto-indent feature.  You are free 
  187.     to edit the templates.  They are provided in ASCII format.  
  188.     Special characters have been added to the list of keywords for 
  189.     the purpose of controlling the indenting.  Below are samples of 
  190.     indent symbols and their meanings:
  191.         
  192.     ┌───────────┬──────────────────────────────────────────────────┐
  193.     │   Symbol  │  Meaning                                         │
  194.     ├───────────┼──────────────────────────────────────────────────┤
  195.     │   .>      │  Indent right after the line.                    │
  196.     ├───────────┼──────────────────────────────────────────────────┤
  197.     │   <.      │  Indent left before the line.                    │
  198.     ├───────────┼──────────────────────────────────────────────────┤
  199.     │   <.>     │  Indent left before the line and indent right    │
  200.     │           │  after the line.                                 │
  201.     ├───────────┼──────────────────────────────────────────────────┤
  202.     │   !       │  This keyword is an exception to the indent rule │
  203.     │           │  and requires special handling.                  │
  204.     └───────────┴──────────────────────────────────────────────────┘
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.     User Manual                                        Page 21 of 30
  237.  
  238.     Geist Microsystems                           CodePrint for C/C++
  239.         
  240.         
  241.     4.5   ERROR MESSAGES
  242.         
  243.     The following is a complete list of error messages.  You may 
  244.     encounter some of them as you process source files with 
  245.     CodePrint.  Corrective actions and/or brief explanations are 
  246.     provided after each error message.
  247.         
  248.     01. Incorrect DOS version.
  249.         
  250.         CodePrint requires DOS version 3.1 or a later version.
  251.         
  252.     02. Printer not ready.
  253.         
  254.         The printer is not available, not powered on, not on-line 
  255.         or out of paper.
  256.         
  257.     03. Source file not found: <source file name>.
  258.  
  259.         The source file does not exist.
  260.  
  261.     04. Source code nesting too deep.
  262.  
  263.         CodePrint cannot process source files with nesting deeper 
  264.         than 20 indent levels.
  265.  
  266.     05. Illegal argument in CP option: /Bn.
  267.  
  268.         The range for legal arguments to the /B option is -1 thru 
  269.         80.
  270.  
  271.     06. Illegal argument in CP option: /Cn.
  272.  
  273.         The range for legal arguments to the /C option is 0 thru 2.
  274.  
  275.     07. Illegal argument in CP option: /Gn.
  276.  
  277.         The range for legal arguments to the /G option is 0 thru 6.
  278.  
  279.     08. Illegal argument in CP option: /Jn.
  280.  
  281.         The range for legal arguments to the /J option is -138 thru 
  282.         138.
  283.  
  284.     09. Illegal argument in CP option: /Kn.
  285.  
  286.         The range for legal arguments to the /K option is 0 thru 3.
  287.  
  288.     10. Illegal argument in CP option: /Mn.    
  289.  
  290.         The range for legal arguments to the /M option is 0 thru 16. 
  291.         
  292.  
  293.  
  294.  
  295.     User Manual                                        Page 22 of 30
  296.  
  297.     Geist Microsystems                           CodePrint for C/C++
  298.  
  299.  
  300.     11. Illegal argument in CP option: /Pn.    
  301.  
  302.         The range for legal arguments to the /P option is 0 thru 7.    
  303.  
  304.     12. Illegal argument in CP option: /Tn.
  305.  
  306.         The range for legal arguments to the /T option is 0 thru 8.
  307.  
  308.     13. Illegal argument in CP option: /Vn.
  309.  
  310.         The range for legal arguments to the /V option is 0 thru 8.
  311.  
  312.     14. Illegal argument in CP option: /Wn.
  313.  
  314.         The range for legal arguments to the /W option is 1.0 thru 
  315.         18.0.
  316.  
  317.     15. Illegal argument in CP option: /Yn.
  318.  
  319.         The range for legal arguments to the /Y option is 0 thru 2.
  320.  
  321.     16. No extension supplied in source file name.
  322.  
  323.         A file name extension must be supplied for the source file 
  324.         name.
  325.  
  326.     17. Unrecognized source file extension.
  327.  
  328.         The recognized source file extensions for the C language are 
  329.         ".c", ".cpp", ".h" and ".hpp".
  330.  
  331.     18. Unrecognized CP option: <option>.
  332.  
  333.         The recognized CP options are: /A /Bn /C /D /E /F /Gn /H /I 
  334.         /Jn /Kn /L /Mn /N /O /Pn /Q /R /S /Tn /U /Vn /Wn /X /Yn /Z. 
  335.  
  336.     19. Print executive/com file not found.
  337.  
  338.         To enable printing, CodePrint requires that PRINT.EXE or 
  339.         PRINT.COM be located in the DOS directory, C:\DOS, or the 
  340.         main directory, C:\.
  341.  
  342.     20. Too many bytes per line.
  343.  
  344.         CodePrint cannot process source files with more than 512 
  345.         bytes per line.
  346.  
  347.     21. Too many tokens per line.
  348.  
  349.         CodePrint cannot process source files with more than 250 
  350.         tokens per line.
  351.  
  352.  
  353.  
  354.     User Manual                                        Page 23 of 30
  355.  
  356.     Geist Microsystems                           CodePrint for C/C++
  357.  
  358.  
  359.     22. Keyword file not found: <keyword file>.
  360.  
  361.         The keyword file does not exist.
  362.  
  363.     23. Too many keywords in keyword file: <keyword file>.
  364.  
  365.         CodePrint cannot process keyword template files with more 
  366.         than 250 keyword entries.
  367.  
  368.     24. Source listing file not found: <source listing file>.
  369.  
  370.         The source listing file does not exist.
  371.  
  372.     25. Too many source files: <number of source files>.
  373.  
  374.         CodePrint cannot process more than 100 source files in batch 
  375.         mode.
  376.  
  377.     26. Print queue is full.
  378.  
  379.         CodePrint uses the DOS PRINT command to process source files 
  380.         in batch mode.  The number of files CodePrint can process 
  381.         at any one time is limited to the number of files specified 
  382.         in the PRINT /Q:queuesize command.  Legal values range from 
  383.         0 to 32. The default is 10.
  384.  
  385.     27. Disk is full.
  386.  
  387.         CodePrint cannot write output to the hard drive because the 
  388.         disk is full.  You can remedy this by freeing up space on 
  389.         your hard drive.
  390.  
  391.     28. The CP environment variable has not been set.
  392.  
  393.         This variable is set when you install the software.  The 
  394.         installation procedure stores this value in CPINI.BAT.  You 
  395.         can also set environment variables from the DOS command line 
  396.         with SET CP=<options>.
  397.  
  398.     29. The CPDRIVE environment variable has not been set.
  399.  
  400.         This variable is set when you install the software.  The 
  401.         installation procedure stores this value in CPINI.BAT.  You 
  402.         can also set environment variables  from the DOS command 
  403.         line with SET CPDRIVE=<destination drive>.
  404.  
  405.     30. The HP environment variable has not been set.
  406.  
  407.         This variable is set when you install the software.  The 
  408.         installation procedure stores this value in CPINI.BAT.  You 
  409.         can also set environment variables from the DOS command line 
  410.         with SET HP=<options>.
  411.  
  412.  
  413.     User Manual                                        Page 24 of 30
  414.  
  415.     Geist Microsystems                           CodePrint for C/C++
  416.  
  417.  
  418.     31. The FORMFEED environment variable has not been set.
  419.  
  420.         This variable is set when you install the software.  The 
  421.         installation procedure stores this value in CPINI.BAT.  You 
  422.         can also set environment variables from the DOS command line 
  423.         with SET FORMFEED=<options>.
  424.  
  425.     32. Unbalanced parentheses.
  426.  
  427.         This indicates a syntax error in the source code. 
  428.  
  429.     33. Unbalanced braces.
  430.  
  431.         This indicates a syntax error in the source code.
  432.  
  433.     34. IF without ELSE.
  434.  
  435.         This indicates a syntax error in the source code.
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.        
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.     User Manual                                        Page 25 of 30
  473.  
  474.     Geist Microsystems                           CodePrint for C/C++
  475.  
  476.  
  477.     INDEX
  478.  
  479.     - A -
  480.  
  481.     /a, 11, 18, 23
  482.     A4, 7
  483.     ANSI, 14
  484.     ASP, 3
  485.     autoindent, 1, 11, 12, 14, 16, 18, 21
  486.  
  487.     - B -
  488.  
  489.     /b, 11, 18, 22, 23
  490.     batch processing, 2, 19
  491.     Borland, 14
  492.  
  493.     - C -
  494.  
  495.     /c, 11, 18, 22, 23
  496.     C++, 1, 3, 9, 19
  497.     carriage width, 16
  498.     command syntax, 9
  499.     compressed, 1, 11, 13, 18
  500.     CP, 5, 9, 10, 11, 19, 22, 23, 24
  501.     CPDRIVE, 5, 24
  502.  
  503.     - D -
  504.  
  505.     /d, 12, 18, 23
  506.     Diablo, 3, 11, 13
  507.     DOS 3, 22
  508.     doublestrike, 1, 11, 13, 15, 16, 18
  509.   
  510.     - E -
  511.  
  512.     /e, 12, 18, 23
  513.     emphasized, 1, 12, 13, 15, 16, 18
  514.     Epson, 3, 11, 13
  515.     error messages, 1, 22
  516.     executive, 7
  517.  
  518.     - F -
  519.  
  520.     /f, 12, 18, 23
  521.     file specification, 9
  522.     flow lines, 12, 16, 18
  523.     form feed, 1, 8, 16, 18, 24
  524.  
  525.     - G -
  526.  
  527.     /g, 12, 16, 18, 22, 23
  528.  
  529.  
  530.  
  531.     User Manual             Page 26 of 30
  532.  
  533.     Geist Microsystems            CodePrint for C/C++
  534.  
  535.  
  536.     - H -
  537.  
  538.     /h 13, 18, 23
  539.     header, 1, 4, 13, 16, 18
  540.     HP, 3, 5, 7, 11, 12, 13, 24
  541.  
  542.     - I -
  543.  
  544.     /i, 13, 18, 23
  545.     IBM, 3, 11, 13, 15
  546.     indent style, 17, 18
  547.     installation, 3, 5
  548.     italics, 13, 18, 23
  549.  
  550.     - J -
  551.  
  552.     /j, 13, 18, 22, 23
  553.     justification, 13, 18
  554.  
  555.     - K -
  556.  
  557.     /k, 14, 18, 22, 23
  558.     K&R, 17
  559.     keyword template, 1, 14, 18, 21
  560.  
  561.     - L -
  562.  
  563.     /l, 14, 18, 23
  564.     landscape, 7, 12, 13
  565.     legal, 7
  566.     letter, 7
  567.     license, 3
  568.     line numbers, 1, 4, 14, 16, 18
  569.     local area network, 2, 6
  570.  
  571.     - M -
  572.  
  573.     /m, 14, 18, 22, 23
  574.     margins, 1, 14, 16, 18
  575.     Microsoft, 14
  576.  
  577.     - N -
  578.  
  579.     /n, 14
  580.     NEC, 3, 11, 13
  581.  
  582.     - O -
  583.  
  584.     /o, 15, 18, 23
  585.     on-line help, 1, 19
  586.     options, 15, 18
  587.  
  588.  
  589.  
  590.     User Manual                                        Page 27 of 30
  591.  
  592.     Geist Microsystems                           CodePrint for C/C++
  593.  
  594.  
  595.     - P -
  596.  
  597.     /p, 15, 18, 23
  598.     packing list, 3
  599.     page breaks, 1, 4, 11, 16, 18
  600.     page numbers, 1, 4, 16, 18
  601.     paper size, 7
  602.     pretty printer, 1, 3, 4, 7, 19
  603.     portrait, 7, 12, 13
  604.     print queue, 6, 20, 24
  605.     printer configuration, 12
  606.     printer port, 15
  607.     product support, 3
  608.  
  609.     - Q -
  610.  
  611.     /q, 15, 18, 23
  612.     quickprint, 15, 18
  613.     Qume, 3, 11, 13, 18
  614.  
  615.     - R -
  616.  
  617.     /r, 18, 23
  618.     reformat, 1, 16, 18, 20
  619.     registration, 3
  620.  
  621.     - S -
  622.  
  623.     /s, 16, 18, 23
  624.     SET, 5, 7, 8, 10, 24
  625.     shareware, 3
  626.     site license, 3
  627.     spaces, 16
  628.     spooling, 2, 6, 19, 20
  629.     symbol set, 5, 7, 24
  630.     syntax errors, 4
  631.  
  632.     - T -
  633.  
  634.     /t, 16, 18, 22, 23
  635.     tab conversion, 16, 18
  636.     tab spacing, 16, 18
  637.  
  638.     - U -
  639.  
  640.     /u, 23
  641.     underline, 11, 13, 15, 16, 18
  642.  
  643.     - V -
  644.  
  645.     /v, 16, 18, 22, 23
  646.     vendor, 3
  647.  
  648.  
  649.     User Manual                                        Page 29 of 30
  650.  
  651.     Geist Microsystems                           CodePrint for C/C++
  652.  
  653.  
  654.     - W -
  655.  
  656.     /w, 16, 18, 22, 23
  657.     warranty, 3
  658.     whitespace, 1
  659.     wild cards, 2, 19
  660.  
  661.     - X -
  662.  
  663.     /x, 16, 18, 23
  664.  
  665.     - Y -
  666.  
  667.     /y, 17, 18, 22, 23
  668.  
  669.     - Z -
  670.  
  671.     /z 12, 23
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.     User Manual                                        Page 30 of 30
  709.  
  710.